Developer CD Series 1995 June: Reference Library/Dev.CD Jun 95/Dev.CD Jun 95.toast/What's New?/New System Software Extensions/QuickDraw 3D ß/Programming/Interfaces/QD3DController.h

C/C++ Source or Header | 1995-04-04 | 8.1 KB | 284 lines | [TEXT/MPS ]

/******************************************************************************
 **                                                                             **
 **     Module:        QD3DController.h                                         **
 **                                                                          **
 **                                                                          **
 **     Purpose:     Each physical device is represented in the system by a     **
 **                 Controller record.  A device driver typically creates     **
 **                 a controller.  Controller feeds changes in coordinates     **
 **                 to a Tracker.                                             **
 **                                                                          **
 **                                                                          **
 **     Copyright (C) 1992-94 Apple Computer, Inc.  All rights reserved.     **
 **                                                                          **
 **                                                                          **
 *****************************************************************************/
#ifndef QD3DController_h
#define QD3DController_h

#if PRAGMA_ONCE
    #pragma once
#endif

#ifdef __cplusplus
extern "C" {
#endif  /*  __cplusplus  */


/******************************************************************************
 **                                                                             **
 **                                Type Definitions                             **
 **                                                                             **
 *****************************************************************************/

#define kQ3ControllerSetChannelMaxDataSize        256

typedef TQ3Status (*TQ3ChannelGetMethod) (
    TQ3ControllerRef                controllerRef,
    unsigned long                channel,
    void                        *data,
    unsigned long                *dataSize);

typedef TQ3Status (*TQ3ChannelSetMethod) (
    TQ3ControllerRef                controllerRef,
    unsigned long                channel,
    const void                    *data,
    unsigned long                dataSize);

typedef struct TQ3ControllerData {
    char                        *signature;
    unsigned long                valueCount;
    unsigned long                channelCount;
    TQ3ChannelGetMethod            channelGetMethod;
    TQ3ChannelSetMethod            channelSetMethod;
} TQ3ControllerData;


/******************************************************************************
 **                                                                             **
 **                                     Routines                                 **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3Status Q3Controller_GetListChanged (
    TQ3Boolean                    *listChanged,
    unsigned long                *serialNumber);

EXPORT TQ3Status Q3Controller_Next(
    TQ3ControllerRef                controllerRef,
    TQ3ControllerRef                *nextControllerRef);

EXPORT TQ3ControllerRef Q3Controller_New(
    const TQ3ControllerData        *controllerData);

EXPORT TQ3Status Q3Controller_Decommission(
    TQ3ControllerRef                controllerRef);

EXPORT TQ3Status Q3Controller_SetActivation(
    TQ3ControllerRef                controllerRef,
    TQ3Boolean                    active);

EXPORT TQ3Status Q3Controller_GetActivation(
    TQ3ControllerRef                controllerRef,
    TQ3Boolean                    *active);

EXPORT TQ3Status Q3Controller_GetSignature(
    TQ3ControllerRef                controllerRef,
    char                        *signature,
    unsigned long                numChars);

EXPORT TQ3Status Q3Controller_SetChannel(
    TQ3ControllerRef                controllerRef,
    unsigned long                channel,
    const void                    *data,
    unsigned long                dataSize);

EXPORT TQ3Status Q3Controller_GetChannel(
    TQ3ControllerRef                controllerRef,
    unsigned long                channel,
    void                        *data,
    unsigned long                *dataSize);

EXPORT TQ3Status Q3Controller_GetValueCount(
    TQ3ControllerRef                controllerRef,
    unsigned long                *valueCount);

EXPORT TQ3Status Q3Controller_SetTracker(
    TQ3ControllerRef                controllerRef,
    TQ3TrackerObject                tracker);

EXPORT TQ3Status Q3Controller_HasTracker(
    TQ3ControllerRef                controllerRef,
    TQ3Boolean                    *hasTracker);

EXPORT TQ3Status Q3Controller_Track2DCursor(
    TQ3ControllerRef                controllerRef,
    TQ3Boolean                    *track2DCursor);

EXPORT TQ3Status Q3Controller_Track3DCursor(
    TQ3ControllerRef                controllerRef,
    TQ3Boolean                    *track3DCursor);

EXPORT TQ3Status Q3Controller_GetButtons(
    TQ3ControllerRef                controllerRef,
    unsigned long                *buttons);

EXPORT TQ3Status Q3Controller_SetButtons(
    TQ3ControllerRef                controllerRef,
    unsigned long                buttons);

EXPORT TQ3Status Q3Controller_GetTrackerPosition(
    TQ3ControllerRef                controllerRef,
    TQ3Point3D                    *position);

EXPORT TQ3Status Q3Controller_SetTrackerPosition(
    TQ3ControllerRef                controllerRef,
    const TQ3Point3D                *position);

EXPORT TQ3Status Q3Controller_MoveTrackerPosition(
    TQ3ControllerRef                controllerRef,
    const TQ3Vector3D            *delta);

EXPORT TQ3Status Q3Controller_GetTrackerOrientation(
    TQ3ControllerRef                controllerRef,
    TQ3Quaternion                *orientation);

EXPORT TQ3Status Q3Controller_SetTrackerOrientation(
    TQ3ControllerRef                controllerRef,
    const TQ3Quaternion            *orientation);

EXPORT TQ3Status Q3Controller_MoveTrackerOrientation(
    TQ3ControllerRef                controllerRef,
    const TQ3Quaternion            *delta);

EXPORT TQ3Status Q3Controller_GetValues(
    TQ3ControllerRef                controllerRef,
    unsigned long                valueCount,
    float                        *values,
    TQ3Boolean                    *changed,
    unsigned long                *serialNumber);

EXPORT TQ3Status Q3Controller_SetValues(
    TQ3ControllerRef                controllerRef,
    const float                    *values,
    unsigned long                valueCount);


/******************************************************************************
 **                                                                             **
 **                                     Routines                                 **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3ControllerStateObject Q3ControllerState_New(
    TQ3ControllerRef                controllerRef);

EXPORT TQ3Status Q3ControllerState_SaveAndReset(
    TQ3ControllerStateObject        controllerStateObject);

EXPORT TQ3Status Q3ControllerState_Restore(
    TQ3ControllerStateObject        controllerStateObject);


/******************************************************************************
 **                                                                             **
 **                                Type Definitions                             **
 **                                                                             **
 *****************************************************************************/

typedef TQ3Status (*TQ3TrackerNotifyFunc) (
    TQ3TrackerObject            trackerObject,
    TQ3ControllerRef            controllerRef);


/******************************************************************************
 **                                                                             **
 **                                     Routines                                 **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3TrackerObject Q3Tracker_New(
    TQ3TrackerNotifyFunc        notifyFunc);

EXPORT TQ3Status Q3Tracker_SetNotifyThresholds(
    TQ3TrackerObject            trackerObject,
    float                    positionThresh,
    float                    orientationThresh);

EXPORT TQ3Status Q3Tracker_GetNotifyThresholds(
    TQ3TrackerObject            trackerObject,
    float                    *positionThresh,
    float                    *orientationThresh);

EXPORT TQ3Status Q3Tracker_SetActivation (
    TQ3TrackerObject            trackerObject,
    TQ3Boolean                active);

EXPORT TQ3Status Q3Tracker_GetActivation (
    TQ3TrackerObject            trackerObject,
    TQ3Boolean                *active);

EXPORT TQ3Status Q3Tracker_GetButtons(
    TQ3TrackerObject            trackerObject,
    unsigned long            *buttons);

EXPORT TQ3Status Q3Tracker_ChangeButtons(
    TQ3TrackerObject            trackerObject,
    TQ3ControllerRef            controllerRef,
    unsigned long            buttons,
    unsigned long            buttonMask);

EXPORT TQ3Status Q3Tracker_GetPosition(
    TQ3TrackerObject            trackerObject,
    TQ3Point3D                *position,
    TQ3Vector3D                *delta,
    TQ3Boolean                *changed,
    unsigned long            *serialNumber);

EXPORT TQ3Status Q3Tracker_SetPosition(
    TQ3TrackerObject            trackerObject,
    TQ3ControllerRef            controllerRef,
    const TQ3Point3D            *position);

EXPORT TQ3Status Q3Tracker_MovePosition(
    TQ3TrackerObject            trackerObject,
    TQ3ControllerRef            controllerRef,
    const TQ3Vector3D        *delta);

EXPORT TQ3Status Q3Tracker_GetOrientation(
    TQ3TrackerObject            trackerObject,
    TQ3Quaternion            *orientation,
    TQ3Quaternion            *delta,
    TQ3Boolean                *changed,
    unsigned long            *serialNumber);

EXPORT TQ3Status Q3Tracker_SetOrientation(
    TQ3TrackerObject            trackerObject,
    TQ3ControllerRef            controllerRef,
    const TQ3Quaternion        *orientation);

EXPORT TQ3Status Q3Tracker_MoveOrientation(
    TQ3TrackerObject            trackerObject,
    TQ3ControllerRef            controllerRef,
    const TQ3Quaternion        *delta);

EXPORT TQ3Status Q3Tracker_SetEventCoordinates(
    TQ3TrackerObject            trackerObject,
    unsigned long            timeStamp,
    unsigned long            buttons,
    const TQ3Point3D            *position,
    const TQ3Quaternion        *orientation);

EXPORT TQ3Status Q3Tracker_GetEventCoordinates(
    TQ3TrackerObject            trackerObject,
    unsigned long            timeStamp,
    unsigned long            *buttons,
    TQ3Point3D                *position,
    TQ3Quaternion            *orientation);

#ifdef __cplusplus
}
#endif  /*  __cplusplus  */

#endif  /*  QD3DController_h  */